Docs: Convert document Overviews and Best Practices to markdown by jordandrako · Pull Request #4512 · microsoft/fluentui

jordandrako · 2018-04-11T00:46:16Z

Pull request checklist

Merge PR ComponentPage: Add Edit On GitHub buttons to page sections #4424 before merging this one.
Include a change request file using $ npm run change

Description of changes

For all components (excluding those in Experiments package)

Add componentUrls to component example pages
Move Overview to ./docs/Overview.md file
Move BestPractices to ./docs/BestPractices.md file
Move Dos to ./docs/Dos.md file
Move Donts to ./docs/Donts.md file

Also changed/updated/fixed:

Rewrote the Themes page to use ComponentPage pattern like all the other components. This enabled me to use markdown for the description.
- Removed hardcoded palette values
- Added palette and semanticColors values using getTheme(true) instead
- See diff here https://github.com/OfficeDev/office-ui-fabric-react/pull/4512/files#diff-d8f8aa6abda1b50ed3efd732fa2d3110R2
Made changes to some functions in theme.ts
- Fixed a bug with _makeSemanticColorsFromPalette that returned empty strings for deprecrated semanticColors.
- Added opt-in argument for getTheme, loadTheme, and createTheme functions to return /* @deprecated */ on deprecated semanticColors. This is mainly for documentation that calls the function (like the rewritten ThemePage). It's opt-in so it doesn't break existing parsers.
- See diff here https://github.com/OfficeDev/office-ui-fabric-react/pull/4512/files#diff-6118735142300c79db4d510e148e28efR43

Let me know if the bugfix and opt-in, or any other added changes should be in separate PRs.

Focus areas to test

Test if edit button link will go to the right place.

mikewheaton · 2018-04-12T16:05:24Z

 Toggle/  @phkuo
 Tooltip/  @micahgodbolt

+## Docs


I think it makes sense to use the same code owners as the rest of the component for now, but over time we'll want to find design owners who can review the usage guidelines.

manishgarg1

manishgarg1 · 2018-04-12T19:04:53Z

Approved with the note that this is just a move. It is hard to read through all comments. Are there any changes that are not just a physical move?

jordandrako · 2018-04-12T19:31:59Z

@manishgarg1 The only changes other than converting to markdown:

Add componentUrl to each page to enable the edit buttons.
Fixing any grammar or spelling mistakes I found in my quick scanning.
Add link to our Icon document to Icon overview and IconButton example.

jordandrako · 2018-04-13T04:11:18Z

Overhauled the "Themes" page so I could use markdown. It now pulls the theme palettes dynamically instead of being hardcoded. Added semanticColors as well.

jordandrako · 2018-04-13T18:31:04Z

Themes page before:

Themes page after:

phkuo · 2018-04-13T19:31:18Z

@jordandrako does it leave out the deprecated semantic slots?

jordandrako · 2018-04-14T00:41:50Z

@phkuo Finished adding @deprecated opt-in functionality and now the documentation shows deprecated color slots as deprecated.

jordandrako · 2018-04-16T19:46:01Z

@Jahnp @dzearing Do you have any issues with the changes here and can we get this wrapped up? See my PR comment for the full list of changes.

Jahnp · 2018-04-17T18:04:49Z

Sorry for the delay @jordandrako. This is an awesome set of changes. Looking now.

* Remove unintended changes in dropdown from #4512

Jordan Janzen added 2 commits April 10, 2018 17:38

Convert getting started page and status page.

3d856ff

First wave of MD files.

3eb00df

jordandrako added the waiting-to-merge label Apr 11, 2018

jordandrako requested review from Jahnp and mikewheaton April 11, 2018 00:46

jordandrako requested review from joschect, lorejoh12, micahgodbolt and srideshpande as code owners April 11, 2018 00:46

Jordan Janzen added 2 commits April 10, 2018 17:47

Use markdown in example page wave 1

ef990d2

Wave 2

97dc75a

jordandrako requested review from ThomasMichon, aditima, atneik, cschleiden, phkuo and yiminwu as code owners April 11, 2018 22:07

Jordan Janzen added 2 commits April 11, 2018 15:10

Initial code owners

41d1d9a

Wave 3

6ca7912

jordandrako removed the waiting-to-merge label Apr 11, 2018

jordandrako changed the title ~~[DON'T MERGE YET] Docs: Convert document Overviews, Dos, and Don'ts to markdown~~ Docs: Convert document Overviews, Dos, and Don'ts to markdown Apr 11, 2018

changes

4737ce7

mikewheaton approved these changes Apr 12, 2018

View reviewed changes

mikewheaton reviewed Apr 12, 2018

View reviewed changes

manishgarg1 approved these changes Apr 12, 2018

View reviewed changes

jordandrako changed the title ~~Docs: Convert document Overviews, Dos, and Don'ts to markdown~~ Docs: Convert document Overviews and Best Practices to markdown Apr 12, 2018

Jordan Janzen added 2 commits April 12, 2018 12:21

Fix Persona owners

a597cf7

Add link to Icon docs to IconButton

8465430

atneik approved these changes Apr 12, 2018

View reviewed changes

Jordan Janzen added 5 commits April 12, 2018 13:56

Use component page for Theme page

6ff7893

Better themes documentation.

f836177

remove commented code

ea6668d

clean

b4dbd48

nit

bfd4955

Merge master

2770413

mikewheaton approved these changes Apr 13, 2018

View reviewed changes

Jordan Janzen added 6 commits April 13, 2018 17:33

Add opt-in for @deprecated comments for documentation.

e070a5b

Add section on loading themes to Overview.

b87e368

Fix mutating state to get rid of console error

029b223

Switch to getTheme from loadTheme, add not for deprecated colors.

3044e6e

changes

4277f43

remove console.logs

91dbca3

Fix code block line height

e5a8c30

Jordan Janzen added 2 commits April 16, 2018 15:59

Merge branch 'master' into docs/convert-to-markdown

9b51eac

changes

f68cfc0

Jahnp approved these changes Apr 17, 2018

View reviewed changes

Jahnp merged commit 4efff92 into microsoft:master Apr 17, 2018

jordandrako pushed a commit to jordandrako/office-ui-fabric-react that referenced this pull request Apr 19, 2018

Remove unintended changes in dropdown from microsoft#4512

1a39ed3

jordandrako added a commit that referenced this pull request Apr 20, 2018

Revert unintended changes in Dropdown from #4512 (#4625)

ef0cfe4

* Remove unintended changes in dropdown from #4512

microsoft locked as resolved and limited conversation to collaborators Aug 31, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Docs: Convert document Overviews and Best Practices to markdown #4512

Docs: Convert document Overviews and Best Practices to markdown #4512
Jahnp merged 24 commits into
microsoft:masterfrom
jordandrako:docs/convert-to-markdown

jordandrako commented Apr 11, 2018 •

edited

Loading

Uh oh!

mikewheaton Apr 12, 2018

Uh oh!

manishgarg1 left a comment

Uh oh!

manishgarg1 commented Apr 12, 2018

Uh oh!

jordandrako commented Apr 12, 2018

Uh oh!

jordandrako commented Apr 13, 2018

Uh oh!

jordandrako commented Apr 13, 2018

Uh oh!

phkuo commented Apr 13, 2018

Uh oh!

jordandrako commented Apr 14, 2018

Uh oh!

jordandrako commented Apr 16, 2018

Uh oh!

Jahnp commented Apr 17, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Uh oh!

Conversation

jordandrako commented Apr 11, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull request checklist

Description of changes

Also changed/updated/fixed:

Focus areas to test

Uh oh!

mikewheaton Apr 12, 2018

Choose a reason for hiding this comment

Uh oh!

manishgarg1 left a comment

Choose a reason for hiding this comment

Uh oh!

manishgarg1 commented Apr 12, 2018

Uh oh!

jordandrako commented Apr 12, 2018

Uh oh!

jordandrako commented Apr 13, 2018

Uh oh!

jordandrako commented Apr 13, 2018

Uh oh!

phkuo commented Apr 13, 2018

Uh oh!

jordandrako commented Apr 14, 2018

Uh oh!

jordandrako commented Apr 16, 2018

Uh oh!

Jahnp commented Apr 17, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

jordandrako commented Apr 11, 2018 •

edited

Loading